Range

Function

This API is used for get Thermal > Fire Detection parameter scale

Request Message

Parameter Description

Table 1

ParameterRangeTypedescription
channel"CH1"…"CHx",
"IP_CH1"…"IP_CHx",
"WIFI_CH1"…"WIFI_CHx"
Channels supported by the device		string arrayIPC can only use "CH1".
page_type“ChannelConfig”
“AlarmConfig”		stringData used to distinguish between the channel configuration page and the alarm configuration page
DeleteIdint arrayid to be deleted (Currently supported id numbers 1 to 8)

Sample:

POST /API/Thermal/Setup/FireDetection/Range HTTP/1.1

{
    "version": "1.0",
    "data":{
        "page_type":"ChannelConfig"
        }

}

Response Message

Parameter Description

Table 2

ParameterRangeTypedescription
channel_infoJson ObjectChannel information see Table 3
page_type"ChannelConfig", "AlarmConfig"stringThe data used to distinguish between the channel configuration page and the alarm configuration page is only needed when setting.
channel_maxintTotal number of channels on the device

Table 3

ParameterRangeTypedescription
CH1Json ObjectJSON See Table 4
...Json Object
IP_CH1Json Object
...Json Object
WIFI_CH1Json Object
...Json Object

Table 4

ParameterRangeTypedescription
status"Offline"
"Online"		stringChannel online status, only for digital channels.
Note: This field does not exist when the channel is online
detectionJson ObjectJson For information see Table 5
alarm_out“Local->1”
”Local->x”
“IP_CH1->1”
“IP_CH1->2”
” IP_CHx->1”
” IP_CHx->2”...
The number of channels depends on the performance of the device		arrayAlarm output channel
latch_time"5s","10s","20s","30s"stringAlarm output time Ipc value 5 10 20 30
record_enableboolSupports channel video switch
post_recording"OFF","5s","10s","20s","30s"stringVideo delay time Ipc value 0 5 10 20 30
send_emailtrue, falseboolSend Email switch
ftp_picture_uploadtrue, falseboolFTP upload switch of channel capture
ftp_video_uploadtrue, falseboolChannel video FTP upload switch
picture_to_cloudtrue, falseboolPicture upload switch
video_to_cloudtrue, falseboolVideo cloud upload switch
light_linkagetrue, falseboolLinkage switch of the white light. When motion is triggered, the linkage triggers the white light
enforcerlight_linkagetrue, falseboolRed and blue light alarm switch
siren_linkagetrue, falseboolsiren alarm switch
http_listeningtrue, falseboolPush switch
record_channel“CH1”…”CH1x”
“IP_CH1”…” IP_CH1x”
“WIFI_CH1”…”
WIFI_CH1x”		arrayVideo alarm output channel
ftp_picture_upload_channel“CH1”…”CH1x”
“IP_CH1”…” IP_CH1x”
“WIFI_CH1”…”
WIFI_CH1x”		arrayCapture image FTP upload alarm output channel
ftp_video_upload_channel“CH1”…”CH1x”
“IP_CH1”…” IP_CH1x”
“WIFI_CH1”…”
WIFI_CH1x”		arrayVideo FTP upload alarm output channel
picture_cloud_channel“CH1”…”CH1x”
“IP_CH1”…” IP_CH1x”
“WIFI_CH1”…”
WIFI_CH1x”		arrayImage upload alarm output channel
video_cloud_channel“CH1”…”CH1x”
“IP_CH1”…” IP_CH1x”
“WIFI_CH1”…”
WIFI_CH1x”		arrayVideo cloud upload alarm output channel
scheduleJSON arraySchedule see Table 6

Table 5

ParameterRangeTypedescription
switchtrue falseboolfunction switch
sensitivity[1,100]intsensitivity

Table 6

ParameterRangeTypedescription
schedule_type“Record”stringtime schedule：Record，AlarmOut，SendEmail
weekJSON arrayweek json see Table 7

Table 7

ParameterRangeTypedescription
daySun,Mon,Tue,Wed
Thu,Fri,Sat		stringMark the day of the week
time0: disables the time range
1: enables the time range		arrayEach array bit identifies half an hour

Sample:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "result": "success",
    "data": {
        "channel_max": 1,
        "channel_info": {
            "type": "object",
            "items": {"CH2": {
                "type": "object",
                "items": {
                    "status": {
                        "description": "Only offline channel has this variable.",
                        "type": "string",
                        "mode": "r",
                        "items": [
                            "Offline",
                            "Online"
                        ]
                    },
                    "detection": {
                        "type": "object",
                        "items": {
                            "switch": {"type": "bool"},
                            "sensitivity": {
                                "type": "int32",
                                "min": 1,
                                "max": 100
                            }
                        }
                    },
                }
            }}
        }
    }
}

Error Code

See Response message body and general error_code for more information.